Data Groups
With few exceptions, data groups must be defined in a device template file (DTF) in order for them to be available for use on a remote device. Which data groups are defined by a device template file depends on protocol, device type, and unique configuration.
CygNet distributes sample device template files for its EIEs, each of which typically serves one or more hardware models along with applicable firmware. Therefore, the data groups described below are only those data groups defined by CygNet in sample device template file(s). Your template(s) might not include some of the data groups described below. Device template files exist to enable users to customize device configurations; however, CygNet is not responsible for changes made by users.
For information about data group definitions and device template files, see Device Template Files.
For more information about data group dependencies, see Data Group Dependencies.
Notes:
- The eProdRPC EIE supports parameters greater than 4095 on WellPilot RPOC devices with v3.0.0+ firmware. If you attempt to use a parameter greater than 4095 and it is not supported by your firmware, the data group element assigned that parameter will not be included in the data group's message.
-
When point processing is performed on history data groups, only closed records will be published and processed to points. If a device has leading timestamped records and returns the current, open record, point processing will not be performed for that record, even though there is data in the DDS transaction. The point record will be updated only when that record is closed. This is to avoid a situation where a point has multiple entries with the same timestamp, since an open record may be still updating values with each new poll, but each update will have the same timestamp. For example, say you start polling for a daily history record at 8:00am, you’ll get the first value at 8:00am, then if you poll every five minutes, you’ll get new values throughout the day at the exact same timestamp. A history record is basically an array of data with a timestamp and values where the values have different process variables for each incremental poll. The timestamp won’t get written until the record is closed, which happens at the end of the time period, in this case, a day.
eProdRPC EIE Data Groups
Browse by letter: [A] [C] [D] [E] [F] [L] [P] [R] [S] [T] [V]
| Data Group Type | Usage Notes |
|---|---|
|
"Accumulator Scan" |
|
|
AccSetup |
"Accumulator Setup" |
|
AnlgInCfg |
"Analog Input Configuration" |
|
AnlgInCtrl |
"Analog Input Control" |
|
AnlgScan |
"Analog IO Status" |
|
The "Configurable Data Group" data group provides a flexible way to create custom data groups on a per-device basis. See Configurable Data Group. |
|
|
Four "Command Message (Configurable)" data groups exist by default:
Additional "Command Message (Configurable)" data groups can be added. If you choose to add a "Command Message (Configurable)" data group, its parameter number must correspond to the appropriate number exposed in the dgElements section of the CmdCfgMsg data group in the device template file. Four corresponding default UIS commands preexist for the four default "Command Message (Configurable)" data groups. In the remote device editor, click View Data for this data group, click Edit, then double-click in the parmIdTxt New Value field to generate a drop-down menu of available commands. |
|
|
The "Command Message" data group enables a user to send one of four commands to a field device:
|
|
|
CntrBalEff |
"Counter Balance Effect" |
|
Composite Data Group |
The "Composite Data Group" is a special kind of data group that enables you to combine any data group element(s) from any data group(s) as long as they are in the same template as the composite data group. The "Composite Data Group" does not appear in a remote device editor unless it has been defined in the relevant device template file. See Composite Data Group. |
|
ComSetup |
"Comm Setup" |
|
For the "Controller Version Information" data group, the following conditions describe when relevant function codes are used:
|
|
|
CtrlParms |
"Control Parameters" |
|
CtrlTimers |
"Control Timers" |
|
CycleRtms |
The "Cycle Run Time History" data group retrieves and stores data for the current runtime cycle and the previous 17 runtime cycles. Values displayed are in total number of seconds and equivalent hh:mm:ss format. |
|
CycleRtms0 |
"Cycle Run Time History (0-59)" |
|
CycleRtms1 |
"Cycle Run Time History (60-119)" |
|
"Date and Time" You can sync the field device time to the host time by clicking Set to host time in the remote device editor. |
|
|
DHCalcRes |
"Downhole Calculation Results" |
|
DHSetup |
"Downhole Setup" |
|
DigInCntrs |
"Digital Input Counters" |
|
DlyElapsRt |
"Daily Elapsed Run Times, 120 day" |
|
DlyFPrd |
The "Daily Fluid Production – 30 Day" data group collects and displays fluid production (in BBL) for the 30 days prior to the current day. Data is displayed in table and corresponding graph format. |
|
DlyFPrd |
The "Daily Fluid Production – 120 Day" data group collects and displays fluid production (in BBL) for the 120 days prior to the current day. Data is displayed in table and corresponding graph format. |
|
DlyRt |
The "Daily Percent Run Times – 8 day" data group collects and displays the percentage of a calendar day that the associated well was operating for the 8 days prior to the current day. Data is displayed in table and graph format. The current day's data displays only a partial day's data since the day is not yet complete. |
|
DlyRt |
The "Daily Percent Run Times – 30 Day" data group collects and displays the percentage of a calendar day that the associated well was operating for the 30 days prior to the current day. Data is displayed in table and graph format. The current day's data displays only a partial day's data since the day is not yet complete. |
|
DlyRt |
The "Daily Percent Run Times – 120 Day" data group collects and displays the percentage of a calendar day that the associated well was operating for the 120 days prior to the current day. Data is displayed in table and graph format. The current day's data displays only a partial day's data since the day is not yet complete. |
|
DownCfg |
The "Downhole Configuration" data group enables you to manually enter downhole configuration settings into the host-side remote device for accurate host calculations. This data group neither reads data from nor sends data to an associated field device. This data group is required if you want to generate downhole cards and/or if you are connecting this device to the CygNet Dynagraph Viewer client application. Click Edit to overwrite existing values. Click Edit then click Add to add rod segment configuration details to the Rod Segment Definition dialog box. The Select Rod Category and Type drop-down menu populates the Rod Type field. |
|
The "Dynagraph Card" data group retrieves and displays surface and/or downhole rod pump cycle data. Data is displayed in table and graph format. Depending on your device model, you must retrieve one or more of these data groups before retrieving dynagraph cards: "Controller Version Information," "Pumpoff Configuration," "Stroke Length," and/or "Stroke Length Settings." These "Dynagraph Card" data groups exist by default:
This data group is required if you are connecting this device to the CygNet Dynagraph Viewer client application. This data group can display up to 5 cards per card type. Downhole card functionality is only available if your device uses firmware that supports function code 25 (FC25). FC25 is used to retrieve downhole dynagraph card data if the associated field device firmware version ID is at least 1.01.02 and the firmware part number is FW-00004-00. Firmware information is retrieved using the Controller Version Information (CtrlInfo) data group. Note: When requesting multiple DynaCards via function code (FC16/FC16Ext), the "Dynagraph Card" data group will first retrieve card marker data. The marker data is later used to correctly divide the buffer of card data into individual cards which may be of unequal lengths. Ordinals associated with the different data group types are hard coded. For instance, ordinal 0 is always Current Card, ordinal 1 is always Shutdown Card, and so forth. Ordinals here do not merely identify a sequence of "Dynagraph Card" data groups. Click Details for table-format plot data and other details. Click Save Reference to save a reference card to the default "Dynagraph Card" data group that uses the data group description Reference Card. This data group references a specific subset of support data groups and elements. These items are required to support a connected system; they are not required if you are not reliant on a connected system for functionality or data. |
|
|
DynaConfig |
The "Pumpoff Configuration" data group defines allowable limits used in dynagraph card display and alarming. Limits include those used to create a pump-off setpoint, including the number of allowable strokes before action must be taken, and peak and minimum load limits, including the number of allowable strokes before action must be taken. Finally, you can choose from several pump-off control methods. The method you choose is reflected in your dynagraph cards. If Min Load (pounds) is set to 0, low load violations are not detected. If Peak Load (pounds) is set to 0, peak load violations are not detected. A red dashed line appears on the dynagraph card to indicate min and peak load limits as defined for this data group. In the Peak/Min Load section, Consecutive Strokes is the acceptable number of consecutive times a load violation (peak or min) is allowed before action must be taken. If set to 0, all load violation limits are disabled. In the Pump-Off Control Setpoint section, Consecutive Strokes is the acceptable number of consecutive strokes that can occur before action must be taken. A value of 1 entered for this field might be too few strokes to reliably indicate that pumpoff is occurring. This data group is required if you want to generate shutdown/pumpoff cards and/or if you are connecting this device to the CygNet Dynagraph Viewer client application. |
|
DynaSup |
The "DynaCard Support" data group is used to calculate a timestamp for pumpup cards or shutdown cards if used in conjunction with an older field device and an external system. Otherwise, it is unneeded. If the WellState is running (current value of 1 or 2), a timestamp is calculated in one of the two following ways:
If the WellState is not running (any current value other than 1 or 2), a timestamp is calculated in one of the two following ways:
This data group is chained in if it is required. Otherwise, it is unaffected. You can manually add one to your Data Groups list for display or troubleshooting purposes, but this is not necessary in order to take advantage of its functionality. |
|
An "Event Directory" data group poll requests all types of events. On the View Data dialog box of the "Event Directory" data group, from the Options drop-down menu, select Get selected event cards to read the cards associated with the highlighted event. A user-defined UIS command can allow you to specify any combination of plain, alarm, and fault events. Event types are:
If you have already implemented eProdRPC templates that do not have the "Event Directory" data group XML, you must manually add the "Event Directory" data group XML and reload the new device definition (device template file) to the Device Definition Service (DDS). It is safest to use the CygNet Device Template Manager utility to do so. |
|
|
"Flow Control Unit Date Time" |
|
|
FcuPress |
"Flow Computer Unit Pressure" |
|
FcuScan |
"Flow Computer Unit Flow Status" |
|
FcuSetup |
"Flow Computer Unit Setup" |
|
FldCalcSet |
"Gross Fluid Calculation Settings" |
|
FldCalcSet |
"Gross Fluid Calculation Settings" |
|
"Load Values Summary" |
|
|
Load Setup |
"Load Violations Setup" |
|
LogDaily |
"Logger Freeze Buffer, Daily" |
|
LogHourly |
"Logger Freeze Buffer, Hourly" |
|
LogSetup |
"Logger Setup" |
|
"Peak Energy Mgmt Config" |
|
|
PwrFailDat |
"Power Failure Data" |
|
"Rod Types" |
|
|
"Sensor Setup" |
|
|
"Single Parameter" Refer to eProdRPC documentation for a complete list of parameters. See eProdRPC Single-Parameter Data Group. |
|
|
StatusData |
The "Status Data" data group is a useful resource if you are using the CygNet Dynagraph Viewer client application. Use it as a catalog of data group elements that can map to UDCs and/or the CygNet Dynagraph Viewer. |
|
Stroke Length |
The "Stroke Length" data group writes a manually entered stroke length to the host-side remote device for various calculations. This value is not written to the actual field device. Card position is typically returned as a % of stroke length between top of shaft and bottom of shaft. To report the position in distance, not %, stroke length is required. The EProdRpc_8500.dtf requires you to use the "Stroke Length" data group to manually set the stroke length for devices. |
|
Stroke Length Settings |
The "Stroke Length Settings" data group retrieves the stroke length configured on the field device. Stroke length on the field device can be overwritten using this data group. Card position is typically returned as a % of stroke length between top of shaft and bottom of shaft. To report the position in distance, not %, stroke length is required. The EProdRpc_8800v204Legacy.dtf requires you to use the "Stroke Length Settings" data group to manually set the stroke length for devices. |
|
"Tank Level Status" |
|
|
TaskFailLg |
"Task Failure Data" |
|
TnkSetup |
"Tank Level Setup" |
|
The "Valve Check Data" data group enables the retrieval of valve load values for both standing and traveling valves. It is available for use with the WellPilotRPOC device type. You must poll VlvChkInfo before polling ValveCheck. |
|
|
VlvCheckInfo |
You must poll VlvChkInfo before polling ValveCheck. |
|
VlvChkInfo |
"Valve Check Support Info" |
|
VSDCfg |
"Yaskawa VSD Configuration" |
|
VSDCtrlSt |
"Yaskawa VSD Control Status" |
|
VSDOpHist |
"Yaskawa VSD Operation History" |
|
VSDRodLCH " |
"Yaskawa VSD Rod Load Ctrl Hist |
|
VSDRodLCS |
"VSD Rod Load Control Setup" |
|
VSDSetup |
"Yaskawa VSD Setup" |
|
VSDStatus |
"Yaskawa VSD Status" |


